exportEnv

object exportEnv : Environment

Environment accessors, where set variables are exported for other steps and tasks.

Export setting can be overridden in most methods, but will export by default.

Functions

contains

open operator fun contains(name: String): Boolean

export

fun export(name: String)

Export name with it's current value.

fun export(name: String, value: String)

Export name with value.

get

operator fun get(name: String): String?

Get name from the environment, or null if it is not present.

getOptional

open override fun getOptional(name: String): String?

Get name from the environment, or null if it is not present.

getOrElse

fun getOrElse(name: String, default: () -> String): String

Get the input passed for name, or default if it was not passed.

getOrPut

fun getOrPut(name: String, default: () -> String): String

Get name, or set default for name and return it.

fun getOrPut(name: String, export: Boolean, default: () -> String): String

Get name from the environment, or set default for name and return it.

getRequired

open override fun getRequired(name: String): String

Get name from the environment, or throw if it is not present.

getValue

open operator override fun getValue(thisRef: Any?, property: KProperty<*>): String?

A delegate based on the property name, for an optional state.

invoke

operator fun invoke(name: String): ReadWriteProperty<Any?, String?>

Delegate for name.

remove

open override fun remove(name: String)

Remove name from the environment.

required

fun required(name: String): ReadWriteProperty<Any?, String>

Optional delegate for name.

set

open operator override fun set(name: String, value: String)

Set name in the environment, following the default export setting for the Environment.

operator fun set(name: String, value: String?)

Set name in the environment, following the default export setting for the Environment.

operator fun set(name: String, export: Boolean, value: String?)

Set name in the environment, exporting according to export.

setValue

open operator override fun setValue(thisRef: Any?, property: KProperty<*>, value: String?)

A delegate based on the property name, for an optional state.

withDefault

fun withDefault(default: () -> String): ReadOnlyProperty<Any?, String>

Get an optional delegate with a default value.

fun withDefault(name: String, default: () -> String): ReadOnlyProperty<Any?, String>

Get an optional delegate with a default value for name.

Properties

local

val local: env

Get env

required

val required: ReadWriteProperty<Any?, String>

Optional delegate.

Sources

js source